Class NATProcessImpl

All Implemented Interfaces:
IPCObject, NATProcess, Process
Direct Known Subclasses:
AsaNatProcessImpl, AsaNatv6ProcessImpl

public class NATProcessImpl extends ProcessImpl implements NATProcess
Information provided by the PKI file:

    \class NatProcess
    
    \brief NatProcess handles and manipulates the NAT process.
    
    \example network().getDevice("Router0").getProcess("NatProcess")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • addNatPool

      public boolean addNatPool(String poolName)
      Information provided by the PKI file:
      
          \brief Adds a NAT pool with the specified name.
          
          \param poolName, the name for the NAT pool.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      addNatPool in interface NATProcess
      Parameters:
      poolName - Takes in a parameter of poolName
      Returns:
      boolean Returns a boolean
    • getNatPool

      public NATPool getNatPool(String poolName)
      Information provided by the PKI file:
      
          \brief Returns the NAT pool with the specified name.
          
          \param poolName, the name of the NAT pool of interest.
          
          \return NatPool, the NatPool object with the specified name.
          
              
      Specified by:
      getNatPool in interface NATProcess
      Parameters:
      poolName - Takes in a parameter of poolName
      Returns:
      NATPool Returns a NATPool
    • getNatPoolAt

      public NATPool getNatPoolAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the NAT pool at the specified index.
          
          \param index, the index of the NAT pool of interest.
          
          \return NatPool, the NatPool object at the specified index.
          
              
      Specified by:
      getNatPoolAt in interface NATProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATPool Returns a NATPool
    • removeNatPool

      public boolean removeNatPool(String poolName)
      Information provided by the PKI file:
      
          \brief Removes the NAT pool with the specified name.
          
          \param poolName, the name of the NAT pool.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      removeNatPool in interface NATProcess
      Parameters:
      poolName - Takes in a parameter of poolName
      Returns:
      boolean Returns a boolean
    • getNatPoolCount

      public int getNatPoolCount()
      Information provided by the PKI file:
      
          \brief Returns the number of NAT pools.
          
          \return int, the number of NAT pools.
          
              
      Specified by:
      getNatPoolCount in interface NATProcess
      Returns:
      int Returns a int
    • getInSrcStaticCount

      public int getInSrcStaticCount()
      Information provided by the PKI file:
      
          \brief Returns the number of inside source static entries.
          
          \return int, the number of inside source static entries.
          
              
      Specified by:
      getInSrcStaticCount in interface NATProcess
      Returns:
      int Returns a int
    • getOutSrcStaticCount

      public int getOutSrcStaticCount()
      Information provided by the PKI file:
      
          \brief Returns the number of outside source static entries.
          
          \return int, the number of outside source static entries.
          
              
      Specified by:
      getOutSrcStaticCount in interface NATProcess
      Returns:
      int Returns a int
    • getInSrcStaticAt

      public NATEntry getInSrcStaticAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the inside source static entry at the specified index.
          
          \param index, the index of the inside source static entry of interest.
          
          \return NatEntry, the NatEntry object at the specified index.
          
              
      Specified by:
      getInSrcStaticAt in interface NATProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATEntry Returns a NATEntry
    • getOutSrcStaticAt

      public NATEntry getOutSrcStaticAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the inside source static entry at the specified index.
          
          \param index, the index of the inside source static entry of interest.
          
          \return NatEntry, the NatEntry object at the specified index.
          
              
      Specified by:
      getOutSrcStaticAt in interface NATProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATEntry Returns a NATEntry
    • clearAllTranslations

      public void clearAllTranslations()
      Information provided by the PKI file:
      
          \brief Clears all NAT translations.
          
              
      Specified by:
      clearAllTranslations in interface NATProcess
    • removeInSrcList

      public boolean removeInSrcList(String aclId)
      Information provided by the PKI file:
      
          \brief Removes the inside source list entry with the specified ACL ID.
          
          \param aclId, the ID of the ACL of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      removeInSrcList in interface NATProcess
      Parameters:
      aclId - Takes in a parameter of aclId
      Returns:
      boolean Returns a boolean
    • removeOutSrcList

      public boolean removeOutSrcList(String aclId)
      Information provided by the PKI file:
      
          \brief Removes the outside source list entry with the specified ACL ID.
          
          \param aclId, the ID of the ACL of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      removeOutSrcList in interface NATProcess
      Parameters:
      aclId - Takes in a parameter of aclId
      Returns:
      boolean Returns a boolean
    • getInSrcList

      public NATList getInSrcList(String aclId)
      Information provided by the PKI file:
      
          \brief Returns the inside source list entry with the specified ACL ID.
          
          \param aclId, the ID of the ACL of interest.
          
          \return NatEntry, the NatEntry object with the specified ACL ID.
          
              
      Specified by:
      getInSrcList in interface NATProcess
      Parameters:
      aclId - Takes in a parameter of aclId
      Returns:
      NATList Returns a NATList
    • getOutSrcList

      public NATList getOutSrcList(String aclId)
      Information provided by the PKI file:
      
          \brief Returns the outside source list entry with the specified ACL ID.
          
          \param aclId, the ID of the ACL of interest.
          
          \return NatEntry, the NatEntry object with the specified ACL ID.
          
              
      Specified by:
      getOutSrcList in interface NATProcess
      Parameters:
      aclId - Takes in a parameter of aclId
      Returns:
      NATList Returns a NATList
    • getInSrcListAt

      public NATList getInSrcListAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the inside source list entry at the specified index.
          
          \param index, the index of the inside source list entry of interest.
          
          \return NatEntry, the NatEntry object at the specified index.
          
              
      Specified by:
      getInSrcListAt in interface NATProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATList Returns a NATList
    • getOutSrcListAt

      public NATList getOutSrcListAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the outside source list entry at the specified index.
          
          \param index, the index of the outside source list entry of interest.
          
          \return NatEntry, the NatEntry object at the specified index.
          
              
      Specified by:
      getOutSrcListAt in interface NATProcess
      Parameters:
      index - Takes in a parameter of index
      Returns:
      NATList Returns a NATList
    • getInSrcListCount

      public int getInSrcListCount()
      Information provided by the PKI file:
      
          \brief Returns the number of inside source list entries.
          
          \return int, the number of inside source list entries.
          
              
      Specified by:
      getInSrcListCount in interface NATProcess
      Returns:
      int Returns a int
    • getOutSrcListCount

      public int getOutSrcListCount()
      Information provided by the PKI file:
      
          \brief Returns the number of outside source list entries.
          
          \return int, the number of outside source list entries.
          
              
      Specified by:
      getOutSrcListCount in interface NATProcess
      Returns:
      int Returns a int
    • getNatTable

      public NATTable getNatTable()
      Information provided by the PKI file:
      
          \brief Returns the NAT table.
          
          \return NatTable, the NatTable object.
          
              
      Specified by:
      getNatTable in interface NATProcess
      Returns:
      NATTable Returns a NATTable